/*
 * Copyright 2019-2021 the original author or authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package top.yein.tethys.system.health;

import reactor.core.publisher.Mono;

/**
 * 策略接口, 用于提供服务运行状况.
 *
 * @author KK (kzou227@qq.com)
 */
@FunctionalInterface
public interface HealthIndicator {

  /**
   * 返回运行健康状况.
   *
   * @param includeDetails 是否应包括或删除详细信息
   * @return 运行健康状况
   */
  default Mono<Health> getHealth(boolean includeDetails) {
    return health().map(h -> includeDetails ? h : h.withoutDetails());
  }

  /**
   * 返回运行健康状况.
   *
   * @return 运行健康状况
   */
  Mono<Health> health();
}
